home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / lcall10.zip / LOGCALL.DOC < prev    next >
Text File  |  1992-07-26  |  9KB  |  283 lines
  1.        ******************************************************************
  2.  
  3.                              LOGCALL Version 1.0
  4.                                 July 26, 1992
  5.  
  6.                         MAXIMUS TODAY'S CALLER LISTER
  7.  
  8.  
  9.  
  10.  
  11.                              Code by Evan Siegworth
  12.                              
  13.                  Docs by Ed Baldwin &
  14.                                      Evan Siegworth
  15.  
  16.  
  17.  
  18.  
  19.                                  USER MANUAL
  20.  
  21.                       Copyright (c) 1992 Evan Siegworth
  22.  
  23.        *******************************************************************
  24.  
  25.  
  26.  
  27.  
  28.   THE LEGAL BUSINESS
  29.   ------------------
  30.  
  31.        LOGCALL operates as specified on the authors' and beta testers'
  32.        systems. Use it at your own risk.  No warranty is stated or
  33.        implied.  The author shall not be responsible for any damages
  34.        resulting from its' use, directly or indirectly.
  35.  
  36.        LOGCALL is distributed as a Freely Available Copyrighted Program.
  37.        You may use, copy, or lose it, but I own the rights to it.
  38.        SysOps may use any compression method acceptable to them for file
  39.        storage on their respective BBS's.  The author asks only that BBS
  40.        advertisements NOT be included in the archive or archive comments.
  41.        No fee may be charged for distribution.
  42.  
  43.        While LOGCALL is freely available for use in non-commercial
  44.        environments, donations to the author will always be gratefully
  45.        accepted.
  46.  
  47.        For information of donations, use on a commercial bbs, or info on
  48.        where to send suggestions, please read the REGIST.DOC included
  49.        in the archive.
  50.  
  51.        LOGCALL will be supported in the MUFFIN Echo, any questions will be
  52.        promptly answered.
  53.  
  54.  
  55.  
  56.  
  57.   THE DISTRIBUTION ARCHIVE (LCALL10.ZIP)
  58.   ---------------------------------------
  59.  
  60.        This archive should contain the following files:
  61.  
  62.        LOGCALL.DOC        -      The complete program documentation.
  63.        LOGCALL.EXE        -      The Executable Program.
  64.        LOGCALL.CTL        -      The Configuration File.
  65.        HISTORY.DOC        -      The program history.
  66.        README.OS2         -      Information for OS/2 Users.
  67.        REGIST.DOC         -      Donation/Registration Information.
  68.            
  69.        
  70.  
  71.   WHAT DOES IT DO
  72.   ---------------
  73.  
  74.        LOGCALL is a Maximus CBCS Today's Callers List Creation utility which
  75.        can create a list of the users whom have called today and a list of
  76.        the last few callers.  It is very configurable.  You set up how you
  77.        want the utility to display the information.
  78.        It creates .BBS files that can be directly displayed to the user.
  79.  
  80.  
  81.  
  82.   INSTALLING LOGCALL
  83.   ------------------
  84.  
  85.        1.  Edit the LOGCALL.CTL file to your systems configuration. An
  86.        explanation of this is provided in a later section.
  87.  
  88.        DONT FORGET!
  89.        2.  Compile the control file.  This is done by entering LOGCALL /U
  90.        at a DOS prompt in the directory that you have both LOGCALL.EXE and
  91.        LOGCALL.CTL located in.  This will create logcall.cfg.
  92.  
  93.        3. That's about it! Test it's functionality.
  94.  
  95.  
  96.  
  97.   CONFIGURATION FILE
  98.   ------------------
  99.  
  100.        The control file tries to follow standard Maximus style .CTL file.
  101.        It also uses several existing MECCA TOKENS as well as several LOGCALL
  102.        specific TOKENS.  The TOKENS will be listed later.
  103.  
  104.        The first section of the control file is used to generate the list of
  105.        users whom have called the system today.  The second section is for
  106.        the last few callers feature.  And the third is for your custom
  107.        display lines.  Each section has a control header that tells the program 
  108.        it is active.  If it is commented out (ie %TodaysCallers) then the rest
  109.        of that section is also automatically commented out.  
  110.        Every section MUST have an 'End' marker!
  111.  
  112. -(SAMPLE .CTL FILE)-
  113.  
  114.             TodaysCaller
  115.  
  116.             %This specifies the Todays Caller section is being used.
  117.  
  118.                     FileName           C:\Max\Misc\Callers.bbs
  119.  
  120.                     %The Drive letter MUST be used, if paths are to be used!
  121.  
  122.                     StatLine           Line
  123.  
  124.                     %Specifies which display line you wish to use.
  125.  
  126.                     Header             Header
  127.  
  128.                     %Specifies which file header you wish to use.
  129.             End
  130.  
  131.             %Ends the section
  132.  
  133.  
  134.             LastFewCallers
  135.  
  136.             %This specifies the Last Few Callers section is being used.
  137.         %Comment out if you dont want to use this function.
  138.     
  139.                     FileName          C:\Max\Misc\Calls.bbs
  140.  
  141.                     %Same as above.
  142.  
  143.                     Statline          Line
  144.  
  145.                     %Tells which display line to be used.  CAN be the same
  146.                 %as the one above.
  147.  
  148.                     Header           Header2
  149.  
  150.                     %Same as above.
  151.  
  152.                     NumberInList
  153.  
  154.                     %Sets the maximum number of callers to be listed 
  155.                 %in a Last Few Callers list.
  156.  
  157.              End
  158.  
  159.              CustomDisplayLines
  160.  
  161.              %Used to set custom string lengths.  The name and city fields
  162.          %will be padded with spaces to to fill the length set below.
  163.  
  164.                     LengthCity       15
  165.  
  166.                     %Sets the length of the City/State field.
  167.  
  168.                     LengthName       15
  169.  
  170.                     %Sets the lenth of the Name/Alias fields.
  171.  
  172.              #Line
  173.          #(display line here...    
  174.     
  175.              %Allows you to create custom lines for the .BBS file to use.
  176.          %Will be explained in detail below.        
  177.  
  178.              #Header
  179.          #(display line here...
  180.  
  181.              %Allows you to create custom headers for the .BBS file to use.
  182.          %Explained below.
  183.          
  184.          End
  185.  
  186. DISPLAY LINES:
  187.     
  188.     This is the unique feature of this program.  You control how the 
  189.     program displays its information.  You put your custom display
  190.     line in the .ctl file right after its respective name.  This allows 
  191.     you to have several lines in the file, but only the ones specified 
  192.     above will be used.  
  193.     Entering the display is alot like entering a line in a MECCA file.
  194.     Straight text will be copied directly.  And there are several 
  195.     informational tokens that can be placed on the line, as well as
  196.     all the regular color tokens.  At this time, however, background
  197.     colors and blinking are not supported.
  198.     For Example:
  199.     A display line like this:
  200.  
  201. User # 23 Evan Siegworth        calling from Channelview, TX
  202.         
  203.     Would be entered like this:
  204.  
  205. #(NAME
  206. #User # [user] [name]  calling from [city]
  207.  
  208.     Its that simple!
  209.     You can spice it up by adding color tokens.
  210.  
  211.     The Header lines are similar yet, they do not use any of the info
  212.     tokens.  This is the line that is displayed at the beginning of the 
  213.     file.
  214.     For Example:
  215.  
  216. <-----------------------TODAYS CALLERS------------------------>
  217.  
  218.     Some important notes:
  219.     Only ONE token per bracket.  [user green name city] will NOT work.
  220.     Your display line MUST be the next line after its name header.
  221.     
  222.     Several display lines are included in the .ctl that came with
  223.     the program.  Use them or create your own.
  224.     You can use ORACLE to test your display lines.
  225.  
  226.        AVAILABLE TOKENS:
  227.  
  228.               All standard MAXIMUS Colour Tokens
  229.               [START] - Logon Time
  230.               [END] - Logoff Time
  231.               [DATE] - Logon Date
  232.               [NAME] - User's Real Name
  233.               [ALIAS] - User's Handle/Alias
  234.               [CITY] - User's City/State
  235.               [BAUD] - User's Baud Rate
  236.               [TOTAL] - Total Number of Calls
  237.               [TIME] - Minutes Spent Online
  238.               [USER] - User Number
  239.  
  240.  
  241.   USING LOGCALL
  242.   -------------
  243.     
  244. **    First, every time the .ctl file is changed, you must update
  245.     the .cfg file.  Run logcall with /u as a parameter to do
  246.     this.
  247.  
  248. **    Second, logcall must reside in the same directory as Max.Log.
  249.  
  250.     
  251. **      Add the line below to your batch file so it runs after every
  252.     caller.  
  253.  
  254.            LOGCALL C:\MAX\LASTUSER.BBS (or the name your system uses ie.
  255.                                         LASTUS01.BBS, LASTUS02.BBS)
  256.     
  257. **    You should delete the today's callers list (ex: Callers.bbs)
  258.     every night.  Put it in your nightly maintance.    
  259.  
  260. **      Next add a command to your MAXIMUS MENUS.CTL file:
  261.     (using Callers.bbs from above sample .ctl file.  substitute own
  262.      name of course)
  263.  
  264.           Display_File  Misc\Callers             Twit "Todays Callers"
  265.  
  266. **      If you wish to utilize the Last Few Callers feature.
  267.     Add a [LINK] command to your WELCOME.BBS or other file that you
  268.         wish to display to the users at logon to show the last few callers.
  269.  
  270.           [LINK]C:\MAX\MISC\CALLS
  271.  
  272.         That should be all that you need to do, besides adding the command to
  273.         your batch file that runs your BBS to execute after EVERY caller.
  274.  
  275.  
  276.   CREDITS
  277.   -------
  278.  
  279.          BORLAND C++  ... Copyrighted by Borland International, Inc.
  280.          ORACLE &
  281.      MAXIMUS CBCS ... Copyrighted by Scott Dudley
  282.          LOGCALL      ... Copyrighted by Evan Siegworth
  283.